<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>glWaitSync - OpenGL ES 3.1 Reference Pages</title>
    <link rel="stylesheet" type="text/css" href="opengl-man.css"/>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
    <script type="text/x-mathjax-config">
            MathJax.Hub.Config({
                MathML: {
                    extensions: ["content-mathml.js"]
                },
                tex2jax: {
                    inlineMath: [['$','$'], ['\\(','\\)']]
                }
            });
        </script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
  </head>
  <body>
    <header/>
    <div class="refentry" id="glWaitSync">
      <div class="titlepage"/>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>glWaitSync — instruct the GL server to block until the specified sync object becomes signaled</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>C Specification</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">void <strong class="fsfunc">glWaitSync</strong>(</code>
              </td>
              <td>GLsync <var class="pdparam">sync</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLbitfield <var class="pdparam">flags</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLuint64 <var class="pdparam">timeout</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>sync</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the sync object whose status to wait on.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>flags</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    A bitfield controlling the command flushing behavior. <em class="parameter"><code>flags</code></em> must be zero.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>timeout</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the timeout that the server should wait before continuing. <em class="parameter"><code>timeout</code></em> must be <code class="constant">GL_TIMEOUT_IGNORED</code>.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">glWaitSync</code> causes the GL server to block and wait until <em class="parameter"><code>sync</code></em> becomes signaled. <em class="parameter"><code>sync</code></em>
            is the name of an existing sync object upon which to wait. <em class="parameter"><code>flags</code></em> and <em class="parameter"><code>timeout</code></em> are currently not used and
            must be set to zero and the special value <code class="constant">GL_TIMEOUT_IGNORED</code>, respectively<a href="#ftn.id-1.6.2.7" class="footnote"><sup class="footnote" id="id-1.6.2.7">[1]</sup></a>. <code class="function">glWaitSync</code> will always wait no longer than an implementation-dependent timeout. The
            duration of this timeout in nanoseconds may be queried by calling <a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with the
            parameter <code class="constant">GL_MAX_SERVER_WAIT_TIMEOUT</code>. There is currently no way to determine whether <code class="function">glWaitSync</code> unblocked
            because the timeout expired or because the sync object being waited on was signaled.
        </p>
        <p>
            If an error occurs, <code class="function">glWaitSync</code> does not cause the GL server to block.
        </p>
      </div>
      <div class="refsect1" id="errors">
        <h2>Errors</h2>
        <p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>sync</code></em> is not the name of a sync object.
        </p>
        <p>
            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>flags</code></em> is not zero.
        </p>
        <p>
            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>timeout</code></em> is not <code class="constant">GL_TIMEOUT_IGNORED</code>.
        </p>
      </div>
      <div class="refsect1" id="versions">
        <h2>API Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; "/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">
                 
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="3">
                <span class="bold"><strong>OpenGL ES API Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.0</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.1</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">glWaitSync</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="glFenceSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glFenceSync</span></span></a>,
            <a class="citerefentry" href="glClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a>
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright <span class="trademark"/>© 2010-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p>
      </div>
      <div class="footnotes">
        <br/>
        <hr class="footnote-hr"/>
        <div id="ftn.id-1.6.2.7" class="footnote">
          <p><a href="#id-1.6.2.7" class="para"><sup class="para">[1] </sup></a><em class="parameter"><code>flags</code></em> and
            <em class="parameter"><code>timeout</code></em> are placeholders for anticipated future extensions of sync object capabilities. They must have these reserved values in
            order that existing code calling <code class="function">glWaitSync</code> operate properly in the presence of such extensions.</p>
        </div>
      </div>
    </div>
    <footer/>
  </body>
</html>
